Get Subscriber Profiles

This API is used to retrieve a subscriber’s existing profiles.

HTTP URL
GET	/api/v2/subscriber/eid/{value}/profiles

NOTE: Provided {type} must be of ‘eid’. Any other input type (i.e., ‘iccid’, ‘imsi’, ‘msisdn’, ‘imei’, ‘imeisv’) will be rejected.

Eligibility

The Requestor is eligible to request information on his own subscribers and his sub-customers’ subscribers.

API Request

Request Structure

N/A

API Response

Response Structure

Parameter	Type	M/O/CM	Description
errorCode	String	O	Failure code. See list below, under ‘Error Codes’ section.
errorMessage	String	O	Failure detailed description. See list below, under ‘Error Codes’ section.
content	Object	O	Array of main response body object displayed when an API call was successful. For a failure, it will be empty.
pageable	Object	O	Paging information object displayed when an API call was successful. For a failure, it will be empty.

Content data objects

Element	Type	M/O/CM	Description
id	UUID	M	Profile ID
name	String	M	Profile name Developer note: Populate with profile alias.
isActive	Boolean	M	Specifies whether the profile is the last known active ICCID. True = Active profile False = Inactive profile
subscriberIdentifiers	Object	M	Subscriber’s profile unique keys

subscriberIdentifiers object

Element	Type	M/O/CM	Description
subscriberId	UUID	M	Subscriber Universal Unique ID
imsiMsisdnPairs	Object	M	Array of IMSI and MSISDN pairs object. Only one can be marked as active (at the most).
iccid	String	M	SIM card serial number
imei	String	O	Device ID registered on the subscriber
imeisv	String	O	Device ID including software version registered on the subscriber

imsiMsisdnPairs object

Element	Type	M/O/CM	Description
imsi	String	M	IMSI registered on the SIM card
msisdn	String	O	Subscriber mobile number - MSISDN Format: international E.164
isLastActive	Boolean	M	Last known IMSI as active indication. Only one can be active at a time. True = Active IMSI False = Inactive IMSI

Element

Type

M/O/CM

Description

imsi

String

IMSI registered on the SIM card

msisdn

String

Subscriber mobile number - MSISDN

Format: international E.164

isLastActive

Boolean

Last known IMSI as active indication. Only one can be active at a time.

True = Active IMSI

False = Inactive IMSI

Pageable data objects

Element	Type	M/O/CM	Description
page	Numeric	M	Page number
size	Numeric	M	Page size. Number of requested elements per page
totalPages	Numeric	M	Total amount of available pages per requested page size
totalElements	Numeric	M	Total amount of retrieved elements

Error Codes

In addition to the general success and failure codes, the following error codes are possible.

Code	Message
GLOBAL_1001	Service unavailable. Please try again
SUBSCRIBER_1002	Subscriber does not exist
SUBSCRIBER_1006	Failed to retrieve subscriber details

Examples

Request Body

Copy

{
}

Response Body: Success ACK

Copy

{
  "errorCode": "",
  "errorMessage": "",
  "content": [
    {
      "id": "d7fcef24-5c03-41dd-9e33-995b7d6f47a4",
      "name": "Profile 1",
      "isActive": true,
      "subscriberIdentifiers": {
        "subscriberId": "e7fcef24-5c03-41dd-9e33-995b7d6f47a7",
        "imsiMsisdnPairs": [
          {
            "imsi": "222116093963849",
            "msisdn": "999022089963159",
            "isLastActive": true
          },
          {
            "imsi": "310380501118337",
            "msisdn": "134044411258337",
            "isLastActive": false
          }
        ],
        "iccid": "8935711001000100255",
        "imei": "354306110218529",
        "imeisv": "3543061102185201"
      }
    },
    {
      "id": "d701e4ad-585b-4219-a85e-ec69fa4e8a06",
      "name": "Profile 2",
      "isActive": false,
      "subscriberIdentifiers": {
        "subscriberId": "e7fcef24-5c03-41dd-9e33-995b7d6f47a7",
        "imsiMsisdnPairs": [
          {
            "imsi": "222013090961859",
            "msisdn": "999013090961859",
            "isLastActive": false
          }
        ],
        "iccid": "8935711001000034535",
        "imei": "354306110218529",
        "imeisv": "3543061102185201"
      }
    }
  ],
  "pageable": {
    "page": 1,
    "size": 10,
    "totalPages": 1,
    "totalElements": 2
  }
}

Response Body: Failure NAK

Copy

{
  "errorCode": "SUBSCRIBER_1006",
  "errorMessage": "Failed to retrieve subscriber details",
  "content": "",
  "pageable": null
}